home *** CD-ROM | disk | FTP | other *** search
/ The Mac 13 / the-mac-13.iso / Shareware City / Utilities / Tower of Babel / Read Me < prev    next >
Encoding:
Text File  |  1995-06-18  |  20.8 KB  |  439 lines  |  [ttro/ttxt]

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                                                         Tower of Babel
  20.  
  21.  
  22.                                                                                     1995 by Peter Schäfer
  23.  
  24.  
  25. "What does it do ?"
  26.  
  27. Tower of Babel simplifies the transfer of plain text files between different system platforms. It converts line break characters as well as high (>127) and low (<32) ASCII characters (diacritical and graphic characters).
  28.  
  29. Currently supported platforms include:
  30.     Macintosh
  31.     DOS (Codepages 437 and 850) and Windows
  32.     UNIX (ISO Latin Nr.1 encoding)
  33.     Atari ST
  34.     DEC
  35. and all systems that use similar ASCII encodings (NeXT, Amiga, etc.). Text files from any platform can be converted to each of the other platforms.
  36.  
  37. In addition, Tower of Babel can
  38.     •     display information about files and folders
  39.     •     modify the type and creator information of Macintosh files
  40.     •     assign color labels
  41.     •     delete resource forks
  42.     •     modify file names (lower case, UPPER CASE, or Capitalized)
  43.     •     truncate file names (8+3 DOS style)
  44.     •     strip potentially bad characters (like :,?,*,etc.) from file names
  45.     •     translate file names using a dictionary of user preferences
  46.  
  47.  
  48. "Why do I need it ?"
  49.  
  50. Although almost all modern operating systems (and DOS :-) share the same scheme for representing text (the famous ASCII code), there is no firm agreement on how to encode line breaks:
  51. UNIX, NeXT, and Amiga systems represent line breaks by a line-feed character (ASCII code 10), Macintosh systems use a carriage-return character (ASCII code 13), and DOS systems (as well as a couple of other systems) use a pair of line-feed and carriage-return characters.
  52. Also, the representation of diacritical characters like ä,ö,é,ñ,etc. and graphic characters like ©,®,π,etc. varies from platform to platform.
  53.  
  54. Apple's File Exchange tool provides a way to convert text files from one encoding to another, but it's awkward to use, especially if you have a whole bunch of files to convert.
  55. Tower of Babel may be exactly what you need (at least, it was exactly what I needed).
  56.  
  57. Note that Tower of Babel is meant only for plain, unformatted text files. For transferring formatted text files, consult the manual of your text processing software.
  58.  
  59.  
  60. "How do I use it ?"
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84. • Select the files you want to convert. All selected files will be displayed in the lower box on the left.
  85. • Check the appropriate options on the right
  86. • Click the Convert button to start the process
  87.  
  88. Balloon Help is available for most items.
  89. All buttons in the dialog have equivalent commands in the File menu.
  90.  
  91. •    Eject (E), Desktop (D)
  92. The familiar buttons you find in all file dialogs.
  93.  
  94. •    Add (O), Add All (A)
  95. Adds files to the list of selected files (the lower list). You may also add files by dropping them on Tower of Babel's icon.
  96.  
  97. •    All Files, Text Files, others…
  98. Influences the appearance of the upper file list: if All Files is selected, all types of files will be displayed (including graphic files, applications, even invisible files).
  99. If Text Files is selected, only plain text files will be displayed.
  100. If you select others…, a dialog pops up where you can select files by a number of criteria, like name, size, modification date, etc. For a description see The Filter Dialog, below.
  101.  
  102. If you add non-text files to your list, make sure not to check any option in the Text Conversion section. It is usually no good idea to modify the contents of non-text files.
  103.  
  104. •    Remove (R), Remove All (L)
  105. Removes files from the lower list. Select files by clicking or arrow key navigation. Holding the shift key while clicking extends the selection.
  106.  
  107. •    Convert (K)
  108. Starts the conversion process for the selected files in the lower list. Before starting, make sure your settings on the right are correct. You may interrupt the conversion process at any time by clicking the Stop button, or skip files by clicking the Skip File button.
  109.  
  110. •    Quit (Q)
  111. Quits Tower of Babel immediately. All settings will be remembered the next time you use the program.
  112.  
  113.  
  114. Text Conversion
  115.  
  116. •    From
  117. Select the original format of the files.
  118. -    Unknown: select this option if you are not sure which format to choose; line breaks will be converted correctly, high-ASCII characters won't
  119. -    Atari ST
  120. -    DEC multinational: for DEC systems
  121. -    DOS (437):    Codepage 437
  122. -    DOS (850):    Codepage 850; if you are not quite sure which Codepage to choose, take this one
  123. -    Macintosh
  124. -    UNIX (ISO Latin Nr. 1): select this option also for NeXT and Amiga text files
  125.  
  126. If your text files don't contain diacritical or graphic characters, it's perfectly safe to select Unknown.
  127.  
  128. If you are working system that is not included in the list, send me a printout of the ASCII table file (included in the Fonts folder). 
  129.  
  130. •    To
  131. Select the destination format.
  132.  
  133. •    Line Breaks
  134. Check this option if you want to convert the line breaks in your text.
  135.  
  136. •    Low ASCII
  137. Check this option if you want to convert low-ASCII characters (i.e. characters whose ASCII codes are smaller than 32, also called control characters). You will probably rarely need it.
  138.  
  139. •    High ASCII
  140. Check this option if your text contains high-ASCII characters (> 127). These include diacritical characters like é,ä,ø,… and special graphic symbols like ©,π,™,…
  141. Note that the encoding of these characters varies quite a bit between different platforms. Tower of Babel will do its best to replace them by identical or at least by similar characters, according to the setting in the menu:
  142.  
  143. -    Re-map:        replaces high-ASCII characters by similar characters, if possible. Most encodings contain diacritical characters, but not all contain the same graphic symbols.
  144.  
  145. -    Plain:    replaces high-ASCII characters by standard characters; for example, "ä" becomes "a",  and "©" becomes "(C)"; the resulting files comply with the 7-bit ASCII code.
  146.  
  147. -    Hex Code:        replaces high-ASCII characters by their ASCII codes (in a notation familiar to C-programmers); for example, "ä" becomes "\0x8a". You may later use a text editor to replace these codes by something more meaningful.
  148.  
  149. If you have selected Unknown, only the Hex Code option is available.
  150.  
  151. Tower of Babel comes with a set of fonts for non-Mac files. If you view files using these fonts, you will get an impression how high-ASCII characters would look on a different system. There is no font for Atari files, but the DOS fonts do a good job as well.
  152.  
  153.  
  154. File Info
  155.  
  156. •    Type
  157. Check this option if you want to modify the file type. Use this option with care, and only if you know what you are doing! For example, the file you are reading now was created as a 'TEXT' file and later converted to a 'ttro' (TeachText read only) file.
  158. To copy the type information from some other file, select the file and choose Set Type from the Special menu.
  159.  
  160. •    Creator
  161. Check this option if you want to modify the file creator. The file creator determines the application that is launched if you double-click a document file. If you change the creator you will usually check the Delete Resource Fork option, too.
  162. To copy the creator information from some other file, select the file and choose Set Creator from the Special menu.
  163.  
  164. •    Label
  165. Check this option if you want to assign color labels to the selected files. For example, color labels are useful to distinguish files from different platforms.
  166. Select "None" (the topmost item in the menu) to remove color labels.
  167.  
  168. •    Delete Resource Fork
  169. Check this option if you want to delete the resource forks of all selected files. Many text processing applications use the resource fork of documents to store additional information (like user preferences). If you transfer a Macintosh file to another platform, this information is probably useless, and may be deleted.
  170.  
  171. •    Keep Original File
  172. If this option is checked,  copies of the files will be created, leaving the original files intact. If it isn't checked, the original files will be modified in place.
  173.  
  174.  
  175. File Name
  176.  
  177. •    Case
  178. Check this option if you want to change the case of file names; for example "letter to mary" becomes "LETTER TO MARY" when UPPERCASE is selected, or "Letter To Mary" when Capitals is selected.
  179.  
  180. •    Truncate (8+3)
  181. Check this option if you want to truncate file names to DOS style. DOS file names consist of 8+3 characters, delimited by a dot (e.g. READ_ME.TXT).
  182.  
  183. •    Remove Bad Chars
  184. Check this option if you want to remove special characters from file names. Most file system reserve some characters for special use. For example ":" characters are not allowed in Macintosh file names. Similarly, other operating systems reserve characters like "?" or "*". If the Remove Bad Chars option is checked, all those characters are replaced by underscores ("_").
  185.  
  186. •    Use Dictionary
  187. If this option is checked, a dictionary is used to translate file names. Suppose you have a file named "Letter to Mary" and want to transfer it to a DOS system where such file names are illegal. Obviously you have to rename it to, say, "mary.txt".
  188. You can do this manually if you have checked the Ask User option, or automatically by checking the Use Dictionary option.
  189. For more information on dictionaries, see Dictionary Info, below.
  190.  
  191. • Ask User
  192. If this option is checked, Tower of Babel lets you rename files manually. It also gives you extra control, because you can skip files during the conversion process.
  193. If this option isn't checked, files will be renamed automatically, according to the settings in the File Name section.
  194.  
  195.  
  196. After having selected files and having set all options appropriately, click the Convert button (or choose Convert from the File menu, or press C).
  197. If you have checked the Ask User option, the process will halt at each file, giving you the opportunity to edit its name, to skip the file, or to stop the whole process.
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207. File: shows the file that is currently processed.
  208. New Name: shows the new file name. If Keep Orig File is checked, a copy of the original will be created; if not, the original file will be renamed.
  209. If you enter a file name that is already in use, Tower of Babel will beep and prompt you again.
  210. The speaker icon turns sound on and off. 
  211. The number of remaining files is shown at the right of the progress bar.
  212.  
  213. Click the OK button to accept the new file name; click Revert to revert to the name that was first proposed.
  214. Click Skip File to skip the file (leaving in intact); click the Stop button to halt the whole process (leaving all remaining files intact, including the current).
  215.  
  216. Use the Return or Enter key as shortcuts for OK; pressing Escape or Command-. is equivalent to Stop.
  217.  
  218. If the Ask User option is not checked, the OK and Revert buttons are missing, but Skip File and Stop are still available. 
  219.  
  220.  
  221. The Preference Menu
  222.  
  223. Use this menu to switch quickly between settings. If you once have set up a list of your most preferred settings, you can quickly switch between them, without having to set all options manually. A preference set stores
  224.     -    the Text Conversion, File Info and File Name options
  225.     -    the settings in the File Filter Dialog
  226.     -    the current dictionary
  227. The list of preferences appears at the bottom of the menu.
  228.  
  229. For example, it could be useful to create preference sets for the "DOS to Mac" conversion, and one for the "Mac to DOS" conversion.
  230.  
  231. •    Add…    Adds the current settings to the list of preferences.
  232. •    Save    Permanently saves changes to the current set
  233. •    Rename…    Renames the current set
  234. •    Delete    Deletes the current set from the list.
  235.  
  236.  
  237. The Special Menu
  238.  
  239. •    Set Type
  240. Fills in the Type edit field with the type information of the currently selected file. 
  241.  
  242. •    Set Creator
  243. Fills in the Creator edit field with the creator information of the currently selected file. 
  244.  
  245. •    Info about…
  246. Displays information about the selected file or folder. Some of the displayed information may be familiar to you from Finder windows. Others may sound like Babylonian to you — don't worry: you needn't know about it unless you are interested in it.
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. - File: the name of the file or folder
  269. - Kind: there are several kinds of files, like documents, application programs, system extensions, aliases, etc.
  270. - Where: the location of the file or folder on your disk
  271. - Type: the file type (e.g. TEXT for plain text files, APPL for applications, etc.)
  272. - Creator: the signature of the application that created the file
  273. - Data Fork: the size of the data fork (in Bytes)
  274. - Resource Fork: the size of the resource fork (in Bytes)
  275. note that either fork may be empty
  276. - Created: date and time of creation
  277. - Modified: date and time of last modification
  278. - Label: a color label assigned by the user
  279.  
  280. - Locked: checked if the file is locked; if you try to modify a locked file Tower of Babel will complain about it
  281. - Alias: checked if the file is an alias, i.e. a reference to another file
  282. - Invisible: checked if the file is not visible from the Finder
  283. - Has Bundle: this file (usually an application) contains additional information for the desktop database
  284. - Name Locked: checked if the name of this file should not be modified; Tower of Babel is able to bypass this lock, but the Finder may be a bit slow in noticing the change
  285. - Stationery: this file works like a stationery pad: if you open it, a new copy will be created
  286. - Has Custom Icon: this file has been assigned a custom icon by the user
  287. - Has Been Inited: checked if the Finder has already taken notice of the file
  288. - Shared Application: this application can be used by multiple users simultaneously
  289. - No INITs: this file contains no INIT resources; almost never checked (to be honest, I don't know what this flag is good for)
  290.  
  291. - New Name: the modified file name (according to the File Name options)
  292. - Dictionary: the dictionary file that is used to translate file names (see below); if the dictionary file is not accessible, Tower of Babel will notify you at startup
  293. - Entries: the number of entries in the dictionary
  294.  
  295. •    Dictionary Info
  296. Shows the contents of the dictionary that is used to translate file names.
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317. Note that the file names on the left are all uppercase since string matching is not case sensitive. That means that "LETTER TO MARY" matches "letter to mary" as well as "Letter To Mary".
  318. Entries are sorted by length, because more specific entries should be preferred over more general ones (for example, "From Peter To *" is more specific than "From * To *")
  319. Note also that translation works in both directions. That's why the entries on the right appear on the left, too.
  320.  
  321. You can't edit the dictionary within Tower of Babel, but you can use any text processing program (like SimpleText) to edit dictionary files. Have a look at Standard Dictionary to get some advice for creating your own dictionaries.
  322. To load another dictionary, select the file in the upper file list and choose Load Dictionary.
  323.  
  324.  
  325. •    Load Dictionary
  326. Loads a dictionary file. It Tower of Babel has any problems reading the file, you will be notified. Verify that the file was loaded correctly by choosing Dictionary Info.
  327. Note that the format for dictionary files has changed from version 1.0 of Tower of Babel. If you want to use an old dictionary, you have use Dictionary Updater, first.
  328.  
  329. Have a look at Standard Dictionary to get some advice for modifying and creating dictionaries.
  330.  
  331.  
  332. The Filter Dialog
  333.  
  334. If you select others… in the pop up menu to the right of the upper file list, a dialog appears where you can establish certain criteria for displaying files. Only files that match these criteria will be shown in the upper list. The dialog is quite similar to the "Find File" dialog in System 7.5.
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348. Click OK button to accept the dialog settings.
  349. Click Revert to revert to the previous settings.
  350. Click Cancel to dismiss the dialog without making any changes.
  351.  
  352. More Choices adds a new criterion. You can specify that files must match all criteria by selecting and in the leftmost menu. Or you can specify that files must match at least one criterion by selecting or.
  353. Note that and binds stronger than or (that means, "a or b and c" will be interpreted as "a or (b and c)").
  354.  
  355. Fewer Choices removes the last criterion.
  356.  
  357. Use the second menu in a row to select a criterion:
  358.     name:    display files whose names match (resp. don't match) a given pattern. Some characters have a special meaning within a pattern:
  359.                 ?            matches any character
  360.                 *            matche any sequence of characters (even an empty one)
  361.                 \            causes the following character to be taken literally; for example,
  362.                                 \? matches a question mark (and nothing else), \* matches an asterisk
  363.                                 (and nothing else), \\ matches a backslash
  364.                 :            colons are not allowed in Macintosh file names; they are replaced by hyphens
  365. Note that these conventions are the same for dictionary entries.
  366.  
  367.     size:    display files whose size if less than (or greater than) a given value
  368.     label:    display files that carry (resp. don't carry) a given color label
  369.     date created:    display files that were created at (or before, after, etc.) a given date. Be aware that the "within x months" settings are not exactly accurate.
  370.     date modified:    display files that were modified at (before, after, etc.) a given date.     
  371.     file type:    display files with a certain type
  372.     creator:    display files that were created by a given application
  373.     lock attribute:    display files that are (resp. are not) locked. Note that you cannot modify the contents of locked files.
  374.     visibility:    display files that are (resp. are not) visible. It is usually no good idea to modify invisible files.
  375.  
  376.  
  377.  
  378. "What do I need to run it ?"
  379.  
  380. Tower of Babel runs on every Macintosh with System 7.0 or later versions. It runs native (fast!) on PowerMacs.
  381.  
  382. In order to read DOS-formatted disks, you need a SuperDrive disk drive (most modern Macs have it), and a system extension like PC Exchange.
  383. You can read UNIX tar files and gzip files with suntar, which as available as freeware (I think). Also, many UNIX systems are able to handle DOS-formatted disks (with the Mtools tool set).
  384.  
  385. Version 1.1 of Tower of Babel fixes a bug that caused it to crash with System 7.0.
  386.  
  387.  
  388. "What does it cost ?"
  389.  
  390. Tower of Babel is postcard-ware. If you use it, please send me a postcard from where you live.
  391. You may freely distribute unmodified copies of Tower of Babel, but not as part of a commercial application.
  392.  
  393.  
  394. "Who did it ?"
  395.  
  396. My address:
  397.  
  398.         Peter Schäfer
  399.         Harztalerstr. 14
  400.         67693 Fischbach
  401.         Germany
  402.         e-mail: pschaefe@informatik.uni-kl.de
  403.  
  404. Questions and suggestions are always welcome.
  405.  
  406.  
  407. "What now ?"
  408.  
  409. Error Messages
  410. ------------------------------------------------------------------------------
  411. "The file "xxx" doesn't seem to be a plain text file …"
  412.     You have selected a file that is not a plain text file (i.e. its type is not 'TEXT'), but you have checked a Text Conversion option (Line Breaks, Low ASCII, or High ASCII). It is no good idea to modify the contents of non-text files unless you know  it is a plain text file with a different type information.
  413. Click Modify to modify the file anyway, click Skip File to skip it, click Stop to stop the process.
  414. If you check don't ask me again this warning message won't appear for subsequent files. Also, this message won't appear if Keep Original File is checked.
  415. ------------------------------------------------------------------------------
  416. "Couldn't find dictionary file …"
  417.     The dictionary file was not found (maybe you deleted it). To get things straight again, select a dictionary file and choose Load Dictionary from the Special menu.
  418. Usually, Tower of Babel finds the dictionary file even if you have moved or renamed it.
  419. ------------------------------------------------------------------------------
  420. "This line contains only one entry …"
  421.     a line in the dictionary file contains only one entry and is therefore useless. This can happen if you forget to separate file names by a tab. Click  OK to ignore the line, click Cancel to dismiss the whole dictionary.
  422. ------------------------------------------------------------------------------
  423. "An Error occured while processing …"
  424.     A file system error (disk full, file locked, etc.) occured. If you click Skip File, the conversion will continue with the next file, if you click Stop it will be stopped.
  425. In any case, the affected file remains intact.
  426. ------------------------------------------------------------------------------
  427. "An Error occured while renaming …"
  428.     The file couldn't be renamed, or its type/creator information couldn't be modified. If the Keep Original File option is checked, the resulting file has a strange name, like "Temp File xxx,xxx,xxx". Continue continues the conversion with the next file, Stop stops it.
  429. Note that Continue is not equivalent to Skip File, because the file is already modified (it just carries the old name).
  430. ------------------------------------------------------------------------------
  431. "Memory is full …"
  432. "System Error …"
  433.     Quit Tower of Babel and start it again. If the error recurrs, increase the memory allocation in the Finder's info window.
  434. ------------------------------------------------------------------------------
  435. "Please communicate this malfunction to the author …"
  436.     …do what the text says. You should hardly ever encounter this error. It indicates a loophole in the mapping tables used for high and low ASCII characters. You can keep on working with Tower of Babel, but some low or high ASCII characters might not be mapped correctly.
  437. ------------------------------------------------------------------------------
  438.  
  439.